<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>OfficeDrawing (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="OfficeDrawing (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OfficeDrawing.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hwpf/usermodel/ObjectsPool.html" title="interface in org.apache.poi.hwpf.usermodel"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.HorizontalPositioning.html" title="enum in org.apache.poi.hwpf.usermodel"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hwpf/usermodel/OfficeDrawing.html" target="_top">FRAMES</a></li>
<li><a href="OfficeDrawing.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li><a href="#nested_class_summary">NESTED</a>&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hwpf.usermodel</p>
<h2 title="Interface OfficeDrawing" class="title">Interface OfficeDrawing</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <strong>OfficeDrawing</strong></pre>
<div class="block">User-friendly interface to office drawing objects.
 <p>
 Some properties and enumeration constants description are quotes from the
 following sources:
 <ul>
 <li>[MS-ODRAW] -- v20110608; Office Drawing Binary File Format; Copyright (c)
 2011 Microsoft Corporation.
 </ul></div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Sergey Vladimirov (vlsergey {at} gmail {dot} com)</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.HorizontalPositioning.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.HorizontalPositioning</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.HorizontalRelativeElement.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.HorizontalRelativeElement</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.VerticalPositioning.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.VerticalPositioning</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.VerticalRelativeElement.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.VerticalRelativeElement</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.HorizontalPositioning.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.HorizontalPositioning</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getHorizontalPositioning()">getHorizontalPositioning</a></strong>()</code>
<div class="block">Returns the type of horizontal positioning to use for a shape</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.HorizontalRelativeElement.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.HorizontalRelativeElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getHorizontalRelative()">getHorizontalRelative</a></strong>()</code>
<div class="block">Specifies a page element relative to which a shape is horizontally
 positioned</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ddf/EscherContainerRecord.html" title="class in org.apache.poi.ddf">EscherContainerRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getOfficeArtSpContainer()">getOfficeArtSpContainer</a></strong>()</code>
<div class="block">Returns escher record that represent shape container (record type is
 <tt>0xF004</tt>).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getPictureData()">getPictureData</a></strong>()</code>
<div class="block">Returns picture data if this shape has (single?) associated picture data</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getRectangleBottom()">getRectangleBottom</a></strong>()</code>
<div class="block">Bottom of the rectangle enclosing shape relative to the origin of the
 shape</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getRectangleLeft()">getRectangleLeft</a></strong>()</code>
<div class="block">Left of rectangle enclosing shape relative to the origin of the shape</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getRectangleRight()">getRectangleRight</a></strong>()</code>
<div class="block">Right of rectangle enclosing shape relative to the origin of the shape</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getRectangleTop()">getRectangleTop</a></strong>()</code>
<div class="block">Top of rectangle enclosing shape relative to the origin of the shape</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getShapeId()">getShapeId</a></strong>()</code>
<div class="block">Shape Identifier</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.VerticalPositioning.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.VerticalPositioning</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getVerticalPositioning()">getVerticalPositioning</a></strong>()</code>
<div class="block">Specifies the type of vertical positioning to use for a shape</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.VerticalRelativeElement.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.VerticalRelativeElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getVerticalRelativeElement()">getVerticalRelativeElement</a></strong>()</code>
<div class="block">Specifies a page element relative to which a shape is vertically
 positioned</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getHorizontalPositioning()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHorizontalPositioning</h4>
<pre><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.HorizontalPositioning.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.HorizontalPositioning</a>&nbsp;getHorizontalPositioning()</pre>
<div class="block">Returns the type of horizontal positioning to use for a shape</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the type of horizontal positioning to use for a shape</dd></dl>
</li>
</ul>
<a name="getHorizontalRelative()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHorizontalRelative</h4>
<pre><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.HorizontalRelativeElement.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.HorizontalRelativeElement</a>&nbsp;getHorizontalRelative()</pre>
<div class="block">Specifies a page element relative to which a shape is horizontally
 positioned</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a page element relative to which a shape is horizontally
         positioned</dd></dl>
</li>
</ul>
<a name="getOfficeArtSpContainer()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOfficeArtSpContainer</h4>
<pre><a href="../../../../../org/apache/poi/ddf/EscherContainerRecord.html" title="class in org.apache.poi.ddf">EscherContainerRecord</a>&nbsp;getOfficeArtSpContainer()</pre>
<div class="block">Returns escher record that represent shape container (record type is
 <tt>0xF004</tt>). Returned record has a child with record type
 <tt>0xF00A</tt> and value of shape id equals to <a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.html#getShapeId()"><code>getShapeId()</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns office art shape container or <tt>null</tt> if not found</dd></dl>
</li>
</ul>
<a name="getPictureData()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPictureData</h4>
<pre>byte[]&nbsp;getPictureData()</pre>
<div class="block">Returns picture data if this shape has (single?) associated picture data</div>
</li>
</ul>
<a name="getRectangleBottom()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRectangleBottom</h4>
<pre>int&nbsp;getRectangleBottom()</pre>
<div class="block">Bottom of the rectangle enclosing shape relative to the origin of the
 shape</div>
</li>
</ul>
<a name="getRectangleLeft()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRectangleLeft</h4>
<pre>int&nbsp;getRectangleLeft()</pre>
<div class="block">Left of rectangle enclosing shape relative to the origin of the shape</div>
</li>
</ul>
<a name="getRectangleRight()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRectangleRight</h4>
<pre>int&nbsp;getRectangleRight()</pre>
<div class="block">Right of rectangle enclosing shape relative to the origin of the shape</div>
</li>
</ul>
<a name="getRectangleTop()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRectangleTop</h4>
<pre>int&nbsp;getRectangleTop()</pre>
<div class="block">Top of rectangle enclosing shape relative to the origin of the shape</div>
</li>
</ul>
<a name="getShapeId()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShapeId</h4>
<pre>int&nbsp;getShapeId()</pre>
<div class="block">Shape Identifier</div>
</li>
</ul>
<a name="getVerticalPositioning()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVerticalPositioning</h4>
<pre><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.VerticalPositioning.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.VerticalPositioning</a>&nbsp;getVerticalPositioning()</pre>
<div class="block">Specifies the type of vertical positioning to use for a shape</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>return the type of vertical positioning to use for a shape</dd></dl>
</li>
</ul>
<a name="getVerticalRelativeElement()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getVerticalRelativeElement</h4>
<pre><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.VerticalRelativeElement.html" title="enum in org.apache.poi.hwpf.usermodel">OfficeDrawing.VerticalRelativeElement</a>&nbsp;getVerticalRelativeElement()</pre>
<div class="block">Specifies a page element relative to which a shape is vertically
 positioned</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a page element relative to which a shape is vertically positioned</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OfficeDrawing.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hwpf/usermodel/ObjectsPool.html" title="interface in org.apache.poi.hwpf.usermodel"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hwpf/usermodel/OfficeDrawing.HorizontalPositioning.html" title="enum in org.apache.poi.hwpf.usermodel"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hwpf/usermodel/OfficeDrawing.html" target="_top">FRAMES</a></li>
<li><a href="OfficeDrawing.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li><a href="#nested_class_summary">NESTED</a>&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
